<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.bukkit.inventory;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.HashMap;<a name="line.3"></a>
<FONT color="green">004</FONT>    import org.bukkit.Material;<a name="line.4"></a>
<FONT color="green">005</FONT>    <a name="line.5"></a>
<FONT color="green">006</FONT>    /**<a name="line.6"></a>
<FONT color="green">007</FONT>     * Interface to the various inventories<a name="line.7"></a>
<FONT color="green">008</FONT>     */<a name="line.8"></a>
<FONT color="green">009</FONT>    public interface Inventory {<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>        /**<a name="line.11"></a>
<FONT color="green">012</FONT>         * Returns the size of the inventory<a name="line.12"></a>
<FONT color="green">013</FONT>         *<a name="line.13"></a>
<FONT color="green">014</FONT>         * @return The inventory size<a name="line.14"></a>
<FONT color="green">015</FONT>         */<a name="line.15"></a>
<FONT color="green">016</FONT>        public int getSize();<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>        /**<a name="line.18"></a>
<FONT color="green">019</FONT>         * Return the name of the inventory<a name="line.19"></a>
<FONT color="green">020</FONT>         *<a name="line.20"></a>
<FONT color="green">021</FONT>         * @return The inventory name<a name="line.21"></a>
<FONT color="green">022</FONT>         */<a name="line.22"></a>
<FONT color="green">023</FONT>        public String getName();<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>        /**<a name="line.25"></a>
<FONT color="green">026</FONT>         * Get the ItemStack found in the slot at the given index<a name="line.26"></a>
<FONT color="green">027</FONT>         *<a name="line.27"></a>
<FONT color="green">028</FONT>         * @param index The index of the Slot's ItemStack to return<a name="line.28"></a>
<FONT color="green">029</FONT>         * @return The ItemStack in the slot<a name="line.29"></a>
<FONT color="green">030</FONT>         */<a name="line.30"></a>
<FONT color="green">031</FONT>        public ItemStack getItem(int index);<a name="line.31"></a>
<FONT color="green">032</FONT>    <a name="line.32"></a>
<FONT color="green">033</FONT>        /**<a name="line.33"></a>
<FONT color="green">034</FONT>         * Stores the ItemStack at the given index<a name="line.34"></a>
<FONT color="green">035</FONT>         *<a name="line.35"></a>
<FONT color="green">036</FONT>         * @param index The index where to put the ItemStack<a name="line.36"></a>
<FONT color="green">037</FONT>         * @param item The ItemStack to set<a name="line.37"></a>
<FONT color="green">038</FONT>         */<a name="line.38"></a>
<FONT color="green">039</FONT>        public void setItem(int index, ItemStack item);<a name="line.39"></a>
<FONT color="green">040</FONT>    <a name="line.40"></a>
<FONT color="green">041</FONT>        /**<a name="line.41"></a>
<FONT color="green">042</FONT>         * Stores the given ItemStacks in the inventory.<a name="line.42"></a>
<FONT color="green">043</FONT>         *<a name="line.43"></a>
<FONT color="green">044</FONT>         * This will try to fill existing stacks and empty slots as good as it can.<a name="line.44"></a>
<FONT color="green">045</FONT>         * It will return a HashMap of what it couldn't fit.<a name="line.45"></a>
<FONT color="green">046</FONT>         *<a name="line.46"></a>
<FONT color="green">047</FONT>         * @param items The ItemStacks to add<a name="line.47"></a>
<FONT color="green">048</FONT>         * @return<a name="line.48"></a>
<FONT color="green">049</FONT>         */<a name="line.49"></a>
<FONT color="green">050</FONT>        public HashMap&lt;Integer, ItemStack&gt; addItem(ItemStack... items);<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>        /**<a name="line.52"></a>
<FONT color="green">053</FONT>         * Removes the given ItemStacks from the inventory.<a name="line.53"></a>
<FONT color="green">054</FONT>         *<a name="line.54"></a>
<FONT color="green">055</FONT>         * It will try to remove 'as much as possible' from the types and amounts you<a name="line.55"></a>
<FONT color="green">056</FONT>         * give as arguments. It will return a HashMap of what it couldn't remove.<a name="line.56"></a>
<FONT color="green">057</FONT>         *<a name="line.57"></a>
<FONT color="green">058</FONT>         * @param items The ItemStacks to remove<a name="line.58"></a>
<FONT color="green">059</FONT>         * @return<a name="line.59"></a>
<FONT color="green">060</FONT>         */<a name="line.60"></a>
<FONT color="green">061</FONT>        public HashMap&lt;Integer, ItemStack&gt; removeItem(ItemStack... items);<a name="line.61"></a>
<FONT color="green">062</FONT>    <a name="line.62"></a>
<FONT color="green">063</FONT>        /**<a name="line.63"></a>
<FONT color="green">064</FONT>         * Get all ItemStacks from the inventory<a name="line.64"></a>
<FONT color="green">065</FONT>         *<a name="line.65"></a>
<FONT color="green">066</FONT>         * @return All the ItemStacks from all slots<a name="line.66"></a>
<FONT color="green">067</FONT>         */<a name="line.67"></a>
<FONT color="green">068</FONT>        public ItemStack[] getContents();<a name="line.68"></a>
<FONT color="green">069</FONT>    <a name="line.69"></a>
<FONT color="green">070</FONT>        /**<a name="line.70"></a>
<FONT color="green">071</FONT>         * Set the inventory's contents<a name="line.71"></a>
<FONT color="green">072</FONT>         *<a name="line.72"></a>
<FONT color="green">073</FONT>         * @return All the ItemStacks from all slots<a name="line.73"></a>
<FONT color="green">074</FONT>         */<a name="line.74"></a>
<FONT color="green">075</FONT>        public void setContents(ItemStack[] items);<a name="line.75"></a>
<FONT color="green">076</FONT>    <a name="line.76"></a>
<FONT color="green">077</FONT>        /**<a name="line.77"></a>
<FONT color="green">078</FONT>         * Check if the inventory contains any ItemStacks with the given materialId<a name="line.78"></a>
<FONT color="green">079</FONT>         *<a name="line.79"></a>
<FONT color="green">080</FONT>         * @param materialId The materialId to check for<a name="line.80"></a>
<FONT color="green">081</FONT>         * @return If any ItemStacks were found<a name="line.81"></a>
<FONT color="green">082</FONT>         */<a name="line.82"></a>
<FONT color="green">083</FONT>        public boolean contains(int materialId);<a name="line.83"></a>
<FONT color="green">084</FONT>    <a name="line.84"></a>
<FONT color="green">085</FONT>        /**<a name="line.85"></a>
<FONT color="green">086</FONT>         * Check if the inventory contains any ItemStacks with the given material<a name="line.86"></a>
<FONT color="green">087</FONT>         *<a name="line.87"></a>
<FONT color="green">088</FONT>         * @param material The material to check for<a name="line.88"></a>
<FONT color="green">089</FONT>         * @return If any ItemStacks were found<a name="line.89"></a>
<FONT color="green">090</FONT>         */<a name="line.90"></a>
<FONT color="green">091</FONT>        public boolean contains(Material material);<a name="line.91"></a>
<FONT color="green">092</FONT>    <a name="line.92"></a>
<FONT color="green">093</FONT>        /**<a name="line.93"></a>
<FONT color="green">094</FONT>         * Check if the inventory contains any ItemStacks matching the given ItemStack<a name="line.94"></a>
<FONT color="green">095</FONT>         * This will only match if both the type and the amount of the stack match<a name="line.95"></a>
<FONT color="green">096</FONT>         *<a name="line.96"></a>
<FONT color="green">097</FONT>         * @param item The ItemStack to match against<a name="line.97"></a>
<FONT color="green">098</FONT>         * @return If any matching ItemStacks were found<a name="line.98"></a>
<FONT color="green">099</FONT>         */<a name="line.99"></a>
<FONT color="green">100</FONT>        public boolean contains(ItemStack item);<a name="line.100"></a>
<FONT color="green">101</FONT>    <a name="line.101"></a>
<FONT color="green">102</FONT>        /**<a name="line.102"></a>
<FONT color="green">103</FONT>         * Check if the inventory contains any ItemStacks with the given materialId and at least the minimum amount specified<a name="line.103"></a>
<FONT color="green">104</FONT>         *<a name="line.104"></a>
<FONT color="green">105</FONT>         * @param materialId The materialId to check for<a name="line.105"></a>
<FONT color="green">106</FONT>         * @param amount The minimum amount to look for<a name="line.106"></a>
<FONT color="green">107</FONT>         * @return If any ItemStacks were found<a name="line.107"></a>
<FONT color="green">108</FONT>         */<a name="line.108"></a>
<FONT color="green">109</FONT>        public boolean contains(int materialId, int amount);<a name="line.109"></a>
<FONT color="green">110</FONT>    <a name="line.110"></a>
<FONT color="green">111</FONT>        /**<a name="line.111"></a>
<FONT color="green">112</FONT>         * Check if the inventory contains any ItemStacks with the given material and at least the minimum amount specified<a name="line.112"></a>
<FONT color="green">113</FONT>         *<a name="line.113"></a>
<FONT color="green">114</FONT>         * @param material The material to check for<a name="line.114"></a>
<FONT color="green">115</FONT>         * @return If any ItemStacks were found<a name="line.115"></a>
<FONT color="green">116</FONT>         */<a name="line.116"></a>
<FONT color="green">117</FONT>        public boolean contains(Material material, int amount);<a name="line.117"></a>
<FONT color="green">118</FONT>    <a name="line.118"></a>
<FONT color="green">119</FONT>        /**<a name="line.119"></a>
<FONT color="green">120</FONT>         * Check if the inventory contains any ItemStacks matching the given ItemStack and at least the minimum amount specified<a name="line.120"></a>
<FONT color="green">121</FONT>         * This will only match if both the type and the amount of the stack match<a name="line.121"></a>
<FONT color="green">122</FONT>         *<a name="line.122"></a>
<FONT color="green">123</FONT>         * @param item The ItemStack to match against<a name="line.123"></a>
<FONT color="green">124</FONT>         * @return If any matching ItemStacks were found<a name="line.124"></a>
<FONT color="green">125</FONT>         */<a name="line.125"></a>
<FONT color="green">126</FONT>        public boolean contains(ItemStack item, int amount);<a name="line.126"></a>
<FONT color="green">127</FONT>    <a name="line.127"></a>
<FONT color="green">128</FONT>        /**<a name="line.128"></a>
<FONT color="green">129</FONT>         * Find all slots in the inventory containing any ItemStacks with the given materialId<a name="line.129"></a>
<FONT color="green">130</FONT>         *<a name="line.130"></a>
<FONT color="green">131</FONT>         * @param materialId The materialId to look for<a name="line.131"></a>
<FONT color="green">132</FONT>         * @return The Slots found.<a name="line.132"></a>
<FONT color="green">133</FONT>         */<a name="line.133"></a>
<FONT color="green">134</FONT>        public HashMap&lt;Integer, ? extends ItemStack&gt; all(int materialId);<a name="line.134"></a>
<FONT color="green">135</FONT>    <a name="line.135"></a>
<FONT color="green">136</FONT>        /**<a name="line.136"></a>
<FONT color="green">137</FONT>         * Find all slots in the inventory containing any ItemStacks with the given material<a name="line.137"></a>
<FONT color="green">138</FONT>         *<a name="line.138"></a>
<FONT color="green">139</FONT>         * @param materialId The material to look for<a name="line.139"></a>
<FONT color="green">140</FONT>         * @return The Slots found.<a name="line.140"></a>
<FONT color="green">141</FONT>         */<a name="line.141"></a>
<FONT color="green">142</FONT>        public HashMap&lt;Integer, ? extends ItemStack&gt; all(Material material);<a name="line.142"></a>
<FONT color="green">143</FONT>    <a name="line.143"></a>
<FONT color="green">144</FONT>        /**<a name="line.144"></a>
<FONT color="green">145</FONT>         * Find all slots in the inventory containing any ItemStacks with the given ItemStack<a name="line.145"></a>
<FONT color="green">146</FONT>         * This will only match slots if both the type and the amount of the stack match<a name="line.146"></a>
<FONT color="green">147</FONT>         *<a name="line.147"></a>
<FONT color="green">148</FONT>         * @param item The ItemStack to match against<a name="line.148"></a>
<FONT color="green">149</FONT>         * @return The Slots found.<a name="line.149"></a>
<FONT color="green">150</FONT>         */<a name="line.150"></a>
<FONT color="green">151</FONT>        public HashMap&lt;Integer, ? extends ItemStack&gt; all(ItemStack item);<a name="line.151"></a>
<FONT color="green">152</FONT>    <a name="line.152"></a>
<FONT color="green">153</FONT>        /**<a name="line.153"></a>
<FONT color="green">154</FONT>         * Find the first slot in the inventory containing an ItemStack with the given materialId<a name="line.154"></a>
<FONT color="green">155</FONT>         *<a name="line.155"></a>
<FONT color="green">156</FONT>         * @param materialId The materialId to look for<a name="line.156"></a>
<FONT color="green">157</FONT>         * @return The Slot found.<a name="line.157"></a>
<FONT color="green">158</FONT>         */<a name="line.158"></a>
<FONT color="green">159</FONT>        public int first(int materialId);<a name="line.159"></a>
<FONT color="green">160</FONT>    <a name="line.160"></a>
<FONT color="green">161</FONT>        /**<a name="line.161"></a>
<FONT color="green">162</FONT>         * Find the first slot in the inventory containing an ItemStack with the given material<a name="line.162"></a>
<FONT color="green">163</FONT>         *<a name="line.163"></a>
<FONT color="green">164</FONT>         * @param materialId The material to look for<a name="line.164"></a>
<FONT color="green">165</FONT>         * @return The Slot found.<a name="line.165"></a>
<FONT color="green">166</FONT>         */<a name="line.166"></a>
<FONT color="green">167</FONT>        public int first(Material material);<a name="line.167"></a>
<FONT color="green">168</FONT>    <a name="line.168"></a>
<FONT color="green">169</FONT>        /**<a name="line.169"></a>
<FONT color="green">170</FONT>         * Find the first slot in the inventory containing an ItemStack with the given stack<a name="line.170"></a>
<FONT color="green">171</FONT>         * This will only match a slot if both the type and the amount of the stack match<a name="line.171"></a>
<FONT color="green">172</FONT>         *<a name="line.172"></a>
<FONT color="green">173</FONT>         * @param item The ItemStack to match against<a name="line.173"></a>
<FONT color="green">174</FONT>         * @return The Slot found.<a name="line.174"></a>
<FONT color="green">175</FONT>         */<a name="line.175"></a>
<FONT color="green">176</FONT>        public int first(ItemStack item);<a name="line.176"></a>
<FONT color="green">177</FONT>    <a name="line.177"></a>
<FONT color="green">178</FONT>        /**<a name="line.178"></a>
<FONT color="green">179</FONT>         * Find the first empty Slot.<a name="line.179"></a>
<FONT color="green">180</FONT>         *<a name="line.180"></a>
<FONT color="green">181</FONT>         * @return The first empty Slot found.<a name="line.181"></a>
<FONT color="green">182</FONT>         */<a name="line.182"></a>
<FONT color="green">183</FONT>        public int firstEmpty();<a name="line.183"></a>
<FONT color="green">184</FONT>    <a name="line.184"></a>
<FONT color="green">185</FONT>        /**<a name="line.185"></a>
<FONT color="green">186</FONT>         * Remove all stacks in the inventory matching the given materialId.<a name="line.186"></a>
<FONT color="green">187</FONT>         *<a name="line.187"></a>
<FONT color="green">188</FONT>         * @param materialId The material to remove<a name="line.188"></a>
<FONT color="green">189</FONT>         */<a name="line.189"></a>
<FONT color="green">190</FONT>        public void remove(int materialId);<a name="line.190"></a>
<FONT color="green">191</FONT>    <a name="line.191"></a>
<FONT color="green">192</FONT>        /**<a name="line.192"></a>
<FONT color="green">193</FONT>         * Remove all stacks in the inventory matching the given material.<a name="line.193"></a>
<FONT color="green">194</FONT>         *<a name="line.194"></a>
<FONT color="green">195</FONT>         * @param material The material to remove<a name="line.195"></a>
<FONT color="green">196</FONT>         */<a name="line.196"></a>
<FONT color="green">197</FONT>        public void remove(Material material);<a name="line.197"></a>
<FONT color="green">198</FONT>    <a name="line.198"></a>
<FONT color="green">199</FONT>        /**<a name="line.199"></a>
<FONT color="green">200</FONT>         * Remove all stacks in the inventory matching the given stack.<a name="line.200"></a>
<FONT color="green">201</FONT>         * This will only match a slot if both the type and the amount of the stack match<a name="line.201"></a>
<FONT color="green">202</FONT>         *<a name="line.202"></a>
<FONT color="green">203</FONT>         * @param item The ItemStack to match against<a name="line.203"></a>
<FONT color="green">204</FONT>         */<a name="line.204"></a>
<FONT color="green">205</FONT>        public void remove(ItemStack item);<a name="line.205"></a>
<FONT color="green">206</FONT>    <a name="line.206"></a>
<FONT color="green">207</FONT>        /**<a name="line.207"></a>
<FONT color="green">208</FONT>         * Clear out a particular slot in the index<a name="line.208"></a>
<FONT color="green">209</FONT>         *<a name="line.209"></a>
<FONT color="green">210</FONT>         * @param index The index to empty.<a name="line.210"></a>
<FONT color="green">211</FONT>         */<a name="line.211"></a>
<FONT color="green">212</FONT>        public void clear(int index);<a name="line.212"></a>
<FONT color="green">213</FONT>    <a name="line.213"></a>
<FONT color="green">214</FONT>        /**<a name="line.214"></a>
<FONT color="green">215</FONT>         * Clear out the whole index<a name="line.215"></a>
<FONT color="green">216</FONT>         */<a name="line.216"></a>
<FONT color="green">217</FONT>        public void clear();<a name="line.217"></a>
<FONT color="green">218</FONT>    }<a name="line.218"></a>




























































</PRE>
</BODY>
</HTML>
